//////////////////////////////////////////////////////////////////////////////////
//                                                                              //
//  This file is part of the buola project (https://code.google.com/p/buola/).  //
//                                                                              //
//  Copyright(c) 2007-2012 Xavi Gratal                                          //
//  gratal AT gmail DOT com                                                     //
//                                                                              //
//  Buola is free software: you can redistribute it and/or modify               //
//  it under the terms of the GNU General Public License as published by        //
//  the Free Software Foundation, either version 3 of the License, or           //
//  (at your option) any later version.                                         //
//                                                                              //
//  Buola is distributed in the hope that it will be useful,                    //
//  but WITHOUT ANY WARRANTY; without even the implied warranty of              //
//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the               //
//  GNU General Public License for more details.                                //
//                                                                              //
//  You should have received a copy of the GNU General Public License           //
//  along with buola.  If not, see <http://www.gnu.org/licenses/>.              //
//                                                                              //
//////////////////////////////////////////////////////////////////////////////////

#ifndef _BUOLA_OS_CUSER_H_
#define _BUOLA_OS_CUSER_H_

#include <buola/buola.h>

namespace buola { namespace os {

///\addtogroup os
///@{

////////////////////////////////////////////////////////////////////////////

/// user information

/// Represents a user in the system, and provides functions to obtain information
/// about it.
///
////////////////////////////////////////////////////////////////////////////

class CUser
{
public:
    ///initialize from user ID
    explicit CUser(int pID)
        :   mID(pID)
    {}

    ///initialize from user name

    ///If the user does not exist, operator bool will return false
    explicit CUser(const std::string &pName);

    ///returns the user ID
    int ID() const    {   return mID; }
    ///returns true if the user is the superuser
    bool IsSuperUser() const  {   return mID==0;  }

    ///user name
    std::string Name() const;
    ///main group for the user
    CGroup Group() const;
    ///list of all groups the user belongs to
    std::vector<CGroup> GroupList() const;
    ///home folder
    std::string Home() const;
    ///user shell
    std::string Shell() const;
    ///real name of the user
    std::wstring RealName() const;

    ///returns true if the user is valid
    explicit operator bool() const    {   return mID!=-1; }
    
private:
    int mID;
};

///@}

/*namespace os*/ } /*namespace buola*/ }

#endif
